right logo image
right logo image
Log on
⯆

API Explorer

Log off

BAHRAIN-OBFv1.0.0 (118 APIs)

API Host: https://ifcsandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "authority_data_request":{
    "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_number":"1234567",
    "mandate_name":"National Anti-Fraud Act",
    "mandate_name_year":"1978"
  }
}
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "authority_data_request":{
    "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_number":"1234567",
    "mandate_name":"National Anti-Fraud Act",
    "mandate_name_year":"1978"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "authority_data_request_list":[{
    "bank-id":"gh.29.uk",
    "authority_data_request":{
      "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer_number":"1234567",
      "mandate_name":"National Anti-Fraud Act",
      "mandate_name_year":"1978"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_authority_data_request - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getauthority_data_requestList_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "authority_data_request":{
    "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_number":"1234567",
    "mandate_name":"National Anti-Fraud Act",
    "mandate_name_year":"1978"
  }
}
Required Roles:
  • CanGetDynamicEntity_authority_data_request - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "authority_data_request":{
    "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_number":"1234567",
    "mandate_name":"National Anti-Fraud Act",
    "mandate_name_year":"1978"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,